<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8" />
<title>GadgetHelper xref</title>
<link type="text/css" rel="stylesheet" href="../../../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../apidocs/com/googlecode/gwt/charts/client/util/GadgetHelper.html">View Javadoc</a></div><pre>

<a class="jxr_linenumber" name="1" href="#1">1</a>   <em class="jxr_comment">/*</em>
<a class="jxr_linenumber" name="2" href="#2">2</a>   <em class="jxr_comment"> * Copyright 2012 Rui Afonso</em>
<a class="jxr_linenumber" name="3" href="#3">3</a>   <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="4" href="#4">4</a>   <em class="jxr_comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with</em>
<a class="jxr_linenumber" name="5" href="#5">5</a>   <em class="jxr_comment"> * the License. You may obtain a copy of the License at</em>
<a class="jxr_linenumber" name="6" href="#6">6</a>   <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="7" href="#7">7</a>   <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em>
<a class="jxr_linenumber" name="8" href="#8">8</a>   <em class="jxr_comment"> * </em>
<a class="jxr_linenumber" name="9" href="#9">9</a>   <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on</em>
<a class="jxr_linenumber" name="10" href="#10">10</a>  <em class="jxr_comment"> * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the</em>
<a class="jxr_linenumber" name="11" href="#11">11</a>  <em class="jxr_comment"> * specific language governing permissions and limitations under the License.</em>
<a class="jxr_linenumber" name="12" href="#12">12</a>  <em class="jxr_comment"> */</em>
<a class="jxr_linenumber" name="13" href="#13">13</a>  <strong class="jxr_keyword">package</strong> com.googlecode.gwt.charts.client.util;
<a class="jxr_linenumber" name="14" href="#14">14</a>  
<a class="jxr_linenumber" name="15" href="#15">15</a>  <strong class="jxr_keyword">import</strong> com.google.gwt.core.client.JavaScriptObject;
<a class="jxr_linenumber" name="16" href="#16">16</a>  
<a class="jxr_linenumber" name="17" href="#17">17</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gwt.charts.client.query.Query;
<a class="jxr_linenumber" name="18" href="#18">18</a>  <strong class="jxr_keyword">import</strong> com.googlecode.gwt.charts.client.query.QueryResponse;
<a class="jxr_linenumber" name="19" href="#19">19</a>  
<a class="jxr_linenumber" name="20" href="#20">20</a>  <em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="21" href="#21">21</a>  <em class="jxr_javadoccomment"> * A helper class to simplify writing Gadgets that use the Google Visualization API.</em>
<a class="jxr_linenumber" name="22" href="#22">22</a>  <em class="jxr_javadoccomment"> * </em>
<a class="jxr_linenumber" name="23" href="#23">23</a>  <em class="jxr_javadoccomment"> * @see &lt;a href="<a href="http://developers.google.com/chart/interactive/docs/reference.html" target="alexandria_uri">http://developers.google.com/chart/interactive/docs/reference.html</a>#GadgetHelper"&gt;GadgetHelper API</em>
<a class="jxr_linenumber" name="24" href="#24">24</a>  <em class="jxr_javadoccomment"> *      Reference&lt;/a&gt;</em>
<a class="jxr_linenumber" name="25" href="#25">25</a>  <em class="jxr_javadoccomment"> */</em>
<a class="jxr_linenumber" name="26" href="#26">26</a>  <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../../../com/googlecode/gwt/charts/client/util/GadgetHelper.html">GadgetHelper</a> <strong class="jxr_keyword">extends</strong> JavaScriptObject {
<a class="jxr_linenumber" name="27" href="#27">27</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="28" href="#28">28</a>  <em class="jxr_javadoccomment">	 * Creates a new instance.</em>
<a class="jxr_linenumber" name="29" href="#29">29</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="30" href="#30">30</a>  <em class="jxr_javadoccomment">	 * @return a new GadgetHelper instance</em>
<a class="jxr_linenumber" name="31" href="#31">31</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="32" href="#32">32</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">native</strong> GadgetHelper create() <em class="jxr_comment">/*<em class="jxr_comment">-{</em></em>
<a class="jxr_linenumber" name="33" href="#33">33</a>  <em class="jxr_comment">		return new $wnd.google.visualization.GadgetHelper();</em>
<a class="jxr_linenumber" name="34" href="#34">34</a>  <em class="jxr_comment">	}-*/</em>;
<a class="jxr_linenumber" name="35" href="#35">35</a>  
<a class="jxr_linenumber" name="36" href="#36">36</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="37" href="#37">37</a>  <em class="jxr_javadoccomment">	 * Create a new instance of google.visualization.Query and set its properties according to values from the gadget</em>
<a class="jxr_linenumber" name="38" href="#38">38</a>  <em class="jxr_javadoccomment">	 * preferences. The type of parameter prefs is _IG_Prefs</em>
<a class="jxr_linenumber" name="39" href="#39">39</a>  <em class="jxr_javadoccomment">	 * &lt;ol&gt;</em>
<a class="jxr_linenumber" name="40" href="#40">40</a>  <em class="jxr_javadoccomment">	 * &lt;li&gt;</em>
<a class="jxr_linenumber" name="41" href="#41">41</a>  <em class="jxr_javadoccomment">	 * Preference _table_query_url is used to set the Query data source URL.&lt;/li&gt;</em>
<a class="jxr_linenumber" name="42" href="#42">42</a>  <em class="jxr_javadoccomment">	 * &lt;li&gt;Preference _table_query_refresh_interval is used to set the Query refresh interval (in seconds).</em>
<a class="jxr_linenumber" name="43" href="#43">43</a>  <em class="jxr_javadoccomment">	 * &lt;/ol&gt;</em>
<a class="jxr_linenumber" name="44" href="#44">44</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="45" href="#45">45</a>  <em class="jxr_javadoccomment">	 * @param prefs gadget API user preferences</em>
<a class="jxr_linenumber" name="46" href="#46">46</a>  <em class="jxr_javadoccomment">	 * @return a new instance of {@link Query}</em>
<a class="jxr_linenumber" name="47" href="#47">47</a>  <em class="jxr_javadoccomment">	 * @see &lt;a href="<a href="http://code.google.com/apis/gadgets/docs/reference.html" target="alexandria_uri">http://code.google.com/apis/gadgets/docs/reference.html</a>#Userprefs_Ref"&gt;Gadget API User</em>
<a class="jxr_linenumber" name="48" href="#48">48</a>  <em class="jxr_javadoccomment">	 *      Preferences&lt;/a&gt;</em>
<a class="jxr_linenumber" name="49" href="#49">49</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="50" href="#50">50</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">native</strong> Query createQueryFromPrefs(JavaScriptObject prefs) <em class="jxr_comment">/*<em class="jxr_comment">-{</em></em>
<a class="jxr_linenumber" name="51" href="#51">51</a>  <em class="jxr_comment">		return $wnd.google.visualization.GadgetHelper.createQueryFromPrefs(prefs);</em>
<a class="jxr_linenumber" name="52" href="#52">52</a>  <em class="jxr_comment">	}-*/</em>;
<a class="jxr_linenumber" name="53" href="#53">53</a>  
<a class="jxr_linenumber" name="54" href="#54">54</a>  	<em class="jxr_javadoccomment">/**</em>
<a class="jxr_linenumber" name="55" href="#55">55</a>  <em class="jxr_javadoccomment">	 * Parameter response is of type google.visualization.QueryResponse. Returns true if the response contains data.</em>
<a class="jxr_linenumber" name="56" href="#56">56</a>  <em class="jxr_javadoccomment">	 * Returns false if the query execution failed and the response does not contain data. If an error occured, this</em>
<a class="jxr_linenumber" name="57" href="#57">57</a>  <em class="jxr_javadoccomment">	 * method displays an error message.</em>
<a class="jxr_linenumber" name="58" href="#58">58</a>  <em class="jxr_javadoccomment">	 * </em>
<a class="jxr_linenumber" name="59" href="#59">59</a>  <em class="jxr_javadoccomment">	 * @param queryResponse</em>
<a class="jxr_linenumber" name="60" href="#60">60</a>  <em class="jxr_javadoccomment">	 * @return true if the response contains data</em>
<a class="jxr_linenumber" name="61" href="#61">61</a>  <em class="jxr_javadoccomment">	 */</em>
<a class="jxr_linenumber" name="62" href="#62">62</a>  	<strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">native</strong> <strong class="jxr_keyword">boolean</strong> validateResponse(QueryResponse queryResponse) <em class="jxr_comment">/*<em class="jxr_comment">-{</em></em>
<a class="jxr_linenumber" name="63" href="#63">63</a>  <em class="jxr_comment">		return $wnd.google.visualization.GadgetHelper.validateResponse(queryResponse);</em>
<a class="jxr_linenumber" name="64" href="#64">64</a>  <em class="jxr_comment">	}-*/</em>;
<a class="jxr_linenumber" name="65" href="#65">65</a>  
<a class="jxr_linenumber" name="66" href="#66">66</a>  	<strong class="jxr_keyword">protected</strong> <a href="../../../../../../com/googlecode/gwt/charts/client/util/GadgetHelper.html">GadgetHelper</a>() {
<a class="jxr_linenumber" name="67" href="#67">67</a>  	}
<a class="jxr_linenumber" name="68" href="#68">68</a>  
<a class="jxr_linenumber" name="69" href="#69">69</a>  }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

